Sfauvel/1990/refactor prometheus metrics using struct #1998

sfauvel · 2024-10-11T16:29:57Z

Content

Create a new crate internal/mithril-metrics that provide tooling to simplify the creation of a metric service.

This PR includes the creation of a new crate that provide a MetricServer and a macro to simply declare a new metric service.

Pre-submit checklist

Branch
- Tests are provided (if possible)
- Crates versions are updated (if relevant)
- CHANGELOG file is updated (if relevant)
- Commit sequence broadly makes sense
- Key commits have useful messages
PR
- No clippy warnings in the CI
- Self-reviewed the diff
- Useful pull request description
- Reviewer requested
Documentation
- Update README file (if relevant)
- Update documentation website (if relevant)
- Add dev blog post (if relevant)

Comments

Functions to update metrics are not removed to avoid too many change in the Signer. It will be done later.

Issue(s)

Closes #1990

mithril-signer/src/metrics/service.rs

github-actions · 2024-10-11T16:42:07Z

Test Results

4 files ±0 55 suites +1 9m 38s ⏱️ +6s
1 355 tests - 3 1 355 ✅ - 3 0 💤 ±0 0 ❌ ±0
1 563 runs - 3 1 563 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 98038e1. ± Comparison against base commit c50f79b.

♻️ This comment has been updated with latest results.

internal/mithril-metric/src/commons.rs

internal/mithril-metric/Cargo.toml

mithril-common/src/entities/epoch.rs

Alenar

LGTM, great works !

Usage looks really nice in the signer.

internal/mithril-metric/Makefile

mithril-signer/src/metrics/service.rs

mithril-signer/Cargo.toml

internal/mithril-metric/src/server.rs

internal/mithril-metric/src/helper.rs

internal/mithril-metric/src/lib.rs

dlachaume

LGTM 👍

jpraynaud

LGTM 👍

internal/mithril-metric/src/metric.rs

mithril-signer/src/metrics/service.rs

…`in `MetricCounter`

…xport_metrics` function create by the macro and remove `metrics_tools`

…om generic in `MetricGauge::record` function and the `round` in getter

* mithril-metric from `0.0.1` to `0.1.0` * mithril-common from `0.4.70` to `0.4.71` * mithril-signer from `0.2.201` to `0.2.202`

github-advanced-security bot found potential problems Oct 11, 2024

View reviewed changes

mithril-signer/src/metrics/service.rs Fixed Show fixed Hide fixed

mithril-signer/src/metrics/service.rs Fixed Show fixed Hide fixed

sfauvel force-pushed the sfauvel/1990/refactor_prometheus_metrics_using_struct branch from 44573fe to 5f32339 Compare October 14, 2024 08:21

jpraynaud reviewed Oct 14, 2024

View reviewed changes

dlachaume reviewed Oct 14, 2024

View reviewed changes

internal/mithril-metric/Cargo.toml Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Oct 14, 2024

View reviewed changes

mithril-common/src/entities/epoch.rs Fixed Show fixed Hide fixed

mithril-common/src/entities/epoch.rs Fixed Show fixed Hide fixed

sfauvel force-pushed the sfauvel/1990/refactor_prometheus_metrics_using_struct branch 3 times, most recently from 3090752 to 1c87643 Compare October 15, 2024 13:21

sfauvel temporarily deployed to testing-preview October 15, 2024 13:36 — with GitHub Actions Inactive

sfauvel temporarily deployed to testing-sanchonet October 15, 2024 13:36 — with GitHub Actions Inactive

sfauvel marked this pull request as ready for review October 15, 2024 13:42

sfauvel requested review from Alenar, jpraynaud and dlachaume October 15, 2024 13:43

Alenar approved these changes Oct 15, 2024

View reviewed changes

dlachaume approved these changes Oct 15, 2024

View reviewed changes

jpraynaud approved these changes Oct 15, 2024

View reviewed changes

internal/mithril-metric/src/metric.rs Outdated Show resolved Hide resolved

internal/mithril-metric/src/metric.rs Outdated Show resolved Hide resolved

mithril-signer/src/metrics/service.rs Outdated Show resolved Hide resolved

sfauvel added 12 commits October 16, 2024 09:23

Example using a dedicated struct

6bc994a

Create a wrapper to prometheus Metrics

b5acdcd

Extract common part from the service file

43f3113

Remove metric constants

b1e0768

Create a internal/mithril-metric crate

941db95

Move the export function to the mothril-metric

d38d52d

Add a macro to generate the metric service

1f9da7b

Rename the MetricsServiceTrait to MetricsServiceExporter

1c0127e

Fix clippy warning on documentation and cargo.toml sort

fdd5adc

Rename MithrilMetric to MetricCollector and recordto `increment…

404bf86

…`in `MetricCounter`

Split commonsfile to helperand metric files

7280f43

Remove feature='full'

1e515d9

sfauvel added 8 commits October 16, 2024 09:24

Use a generic instead of Epoch for MetricGauge

141fb1e

Use a generic instead of Epoch for MetricGauge

6ce5a1e

Move code of the function metrics_tools::export_metrics into the `e…

53bcd54

…xport_metrics` function create by the macro and remove `metrics_tools`

The name of the metric must be provided to the macro

51cad72

Upgrade versions and fix fmt check warning

fa1e5fa

Harmonize log messages

97c31a5

Add missing documentation

441dd74

Add Send + Sync to MetricServiceExporter trait and remove Copy fr…

cedeb26

…om generic in `MetricGauge::record` function and the `round` in getter

sfauvel force-pushed the sfauvel/1990/refactor_prometheus_metrics_using_struct branch from 0746b9d to cedeb26 Compare October 16, 2024 07:30

sfauvel added 3 commits October 16, 2024 10:33

Fix code in documentation

006e9ef

Remove obsolete functions from signer MetricsService

78b1131

chore: upgrade crate versions

98038e1

* mithril-metric from `0.0.1` to `0.1.0` * mithril-common from `0.4.70` to `0.4.71` * mithril-signer from `0.2.201` to `0.2.202`

sfauvel temporarily deployed to testing-preview October 16, 2024 13:14 — with GitHub Actions Inactive

sfauvel temporarily deployed to testing-sanchonet October 16, 2024 13:14 — with GitHub Actions Inactive

sfauvel merged commit d1ce9a3 into main Oct 16, 2024
48 checks passed

sfauvel deleted the sfauvel/1990/refactor_prometheus_metrics_using_struct branch October 16, 2024 13:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sfauvel/1990/refactor prometheus metrics using struct #1998

Sfauvel/1990/refactor prometheus metrics using struct #1998

sfauvel commented Oct 11, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024 •

edited

Loading

Alenar left a comment

dlachaume left a comment

jpraynaud left a comment

Sfauvel/1990/refactor prometheus metrics using struct #1998

Sfauvel/1990/refactor prometheus metrics using struct #1998

Conversation

sfauvel commented Oct 11, 2024 • edited Loading

Content

Pre-submit checklist

Comments

Issue(s)

github-actions bot commented Oct 11, 2024 • edited Loading

Test Results

Alenar left a comment

Choose a reason for hiding this comment

dlachaume left a comment

Choose a reason for hiding this comment

jpraynaud left a comment

Choose a reason for hiding this comment

sfauvel commented Oct 11, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024 •

edited

Loading